org.eclipse.vtp.framework.engine.http
Class DeploymentSession

java.lang.Object
  org.eclipse.vtp.framework.engine.http.DeploymentSession

All Implemented Interfaces:

ISessionDescriptor

public class DeploymentSession
extends java.lang.Object
implements ISessionDescriptor

An active session on the HTTP connector.

Author:

Lonnie Pryor

Method Summary

IDocument	abort(javax.servlet.http.HttpSession httpSession, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpReesponse, java.lang.String prefix, java.util.Map variableValues, java.util.Map parameterValues) Aborts this session.
void	clearAttribute(java.lang.String attributeName) Clears the value of the specified session attribute.
java.lang.Object	getAttribute(java.lang.String attributeName) Returns the value of the session attribute with the specified name or null if no such attribute exists.
java.lang.String[]	getAttributeNames() Returns the names of the attributes set in the session.
java.lang.Object	getService(java.lang.String identifier) Returns the service selected for the specified identifier or null if no such service exists.
java.lang.String[]	getServiceIdentifiers() Returns the identifiers of all the externally-provided services.
ISession	getSession() Returns the session.
java.lang.String	getSessionID() Returns the ID of the session being described.
IDocument	next(javax.servlet.http.HttpSession httpSession, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpReesponse, java.lang.String prefix, java.util.Map variableValues, java.util.Map parameterValues) Preforms the next step in this session.
void	setAttribute(java.lang.String attributeName, java.lang.Object attributeValue) Sets the value of the specified session attribute or clears it if the supplied value is null.
IDocument	start(javax.servlet.http.HttpSession httpSession, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpReesponse, java.lang.String prefix, java.util.Map variableValues, java.util.Map parameterValues, java.lang.String brand) Preforms the first step in this session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSession

public ISession getSession()

Returns the session.

Returns:

The session.

start

public IDocument start(javax.servlet.http.HttpSession httpSession,
                       javax.servlet.http.HttpServletRequest httpRequest,
                       javax.servlet.http.HttpServletResponse httpReesponse,
                       java.lang.String prefix,
                       java.util.Map variableValues,
                       java.util.Map parameterValues,
                       java.lang.String brand)

Preforms the first step in this session.

Parameters:

httpSession - The HTTP session.

httpRequest - The HTTP request.

httpResponse - The HTTP response.

Returns:

The next document to render.

next

public IDocument next(javax.servlet.http.HttpSession httpSession,
                      javax.servlet.http.HttpServletRequest httpRequest,
                      javax.servlet.http.HttpServletResponse httpReesponse,
                      java.lang.String prefix,
                      java.util.Map variableValues,
                      java.util.Map parameterValues)

Preforms the next step in this session.

Parameters:

httpSession - The HTTP session.

httpRequest - The HTTP request.

httpResponse - The HTTP response.

Returns:

The next document to render.

abort

public IDocument abort(javax.servlet.http.HttpSession httpSession,
                       javax.servlet.http.HttpServletRequest httpRequest,
                       javax.servlet.http.HttpServletResponse httpReesponse,
                       java.lang.String prefix,
                       java.util.Map variableValues,
                       java.util.Map parameterValues)

Aborts this session.

Parameters:

httpSession - The HTTP session.

httpRequest - The HTTP request.

httpResponse - The HTTP response.

Returns:

The last document to render.

getSessionID

public java.lang.String getSessionID()

Description copied from interface: ISessionDescriptor

Returns the ID of the session being described.

Specified by:

getSessionID in interface ISessionDescriptor

Returns:

The ID of the session being described.

getServiceIdentifiers

public java.lang.String[] getServiceIdentifiers()

Description copied from interface: ISessionDescriptor

Returns the identifiers of all the externally-provided services.

Specified by:

getServiceIdentifiers in interface ISessionDescriptor

Returns:

The identifiers of all the externally-provided services.

getService

public java.lang.Object getService(java.lang.String identifier)
                            throws java.lang.NullPointerException

Description copied from interface: ISessionDescriptor

Returns the service selected for the specified identifier or null if no such service exists.

Specified by:

getService in interface ISessionDescriptor

Parameters:

identifier - The identifier of the service to return.

Returns:

The service selected for the specified identifier or null if no such service exists.

Throws:

java.lang.NullPointerException - If the supplied identifier is null.

getAttributeNames

public java.lang.String[] getAttributeNames()

Description copied from interface: ISessionDescriptor

Returns the names of the attributes set in the session.

Specified by:

getAttributeNames in interface ISessionDescriptor

Returns:

The names of the attributes set in the session.

getAttribute

public java.lang.Object getAttribute(java.lang.String attributeName)
                              throws java.lang.NullPointerException

Description copied from interface: ISessionDescriptor

Returns the value of the session attribute with the specified name or null if no such attribute exists.

Specified by:

getAttribute in interface ISessionDescriptor

Parameters:

attributeName - The name of the session attribute to return.

Returns:

The value of the session attribute with the specified name or null if no such attribute exists.

Throws:

java.lang.NullPointerException - If the specified attribute name is null.

setAttribute

public void setAttribute(java.lang.String attributeName,
                         java.lang.Object attributeValue)
                  throws java.lang.NullPointerException

Description copied from interface: ISessionDescriptor

Sets the value of the specified session attribute or clears it if the supplied value is null.

Specified by:

setAttribute in interface ISessionDescriptor

Parameters:

attributeName - The name of the session attribute to set.

attributeValue - The value to set the attribute to or null to clear the attribute.

Throws:

java.lang.NullPointerException - If the specified attribute name is null.

clearAttribute

public void clearAttribute(java.lang.String attributeName)
                    throws java.lang.NullPointerException

Description copied from interface: ISessionDescriptor

Clears the value of the specified session attribute.

Specified by:

clearAttribute in interface ISessionDescriptor

Parameters:

attributeName - The name of the session attribute to clear.

Throws:

java.lang.NullPointerException - If the specified attribute name is null.